R Source

You can use the R source node to run an R script that will generated table outputs than can then be connected directly to a target node, or to tables from another source to create a data mashup.

There are a few ways in which to construct your R script: they can be downloaded from the Pyramid Marketplace, imported from the Pyramid content manager, or written or pasted directly to the R node's Properties panel.

Configure the R Source

Add the R source node to the data from and then go to its Properties panel to configure the script.

Script

There are four ways in which you can provide the R script:

• Generate Your Script: get an AI-generated R script based on a given prompt (purple arrow above).
• Marketplace: download a script from the Pyramid Marketplace (red arrow above). Once downloaded, the script will appear in the script window.
• Pick a Script: open the content manager folder tree to select a script that was built and saved in Pyramid (green arrow above). Once the script is selected, it will appear in the script window.
• Write or Paste a Script: write or paste a script directly into the script window.

Use AI to Generate a Script

Pyramid's Generate AI integration lets you use AI to generate R statements. This is useful if you want to generate code quickly, or don't know the syntax, for instance. To do this, click the Gen AI icon from the Properties panel. In the text field at the top of the Generate Your R dialog, enter a description of the query you want to perform.

The dialog for generating your script contains the following fields and buttons:

• Text Field: enter a description of the query you want to perform and click the arrow to enter your query description and return a it as a script.
• Script Window: the AI-generated script will appear in the scripting window.
• Explain Code: open an AI-generated explanation of the script that was returned in the scripting window.
• Apply: apply the script to the Query node.
• Cancel: close the dialog without applying any changes.

Explain Code

Use the Explain Script function to produce an AI-generated explanation of what the script does. Each time you click the Explain Script button, a new explanation is generated. This explanation can be generated regardless of the method used to generate the script itself. For more information, see Explain Script.

This explanation can be copied, and then pasted to the "Description" field, for instance.

Warning: AI-generated assets are generated from public domain algorithms, which can produce both erroneous and inconsistent or random results. Use at your own risk.

Environment

Choose the managed R environment (blue highlight above) that uses the required R version and packages.

Pyramid enables Admins to create multiple virtual environments, where each of these environments can use a different R version and different 3rd party packages.

Packages

View the list of packages that have been downloaded to the currently selected virtual R environment (yellow highlight above).

• Click here to learn more about virtual scripting environments.

Configure the Output

The Output window displays the output of the current script. Each row in the listing represents a column:

• Data Frame: the data frame of the column.
• Column Name: the name of the column.
• Type: the data type of the columns.
• Size: the size of the column

To edit a column output, click on it to open its fly-out menu (green arrow below). To delete a column, click its delete icon, and to add a column, click the plus icon.

Data Frame

When downloading a Marketplace script, Pyramid detects the output automatically. When writing your own script, or selecting a shared script, users must manually add the output columns to the Output window.

Auto Detect

Click 'Auto Detect' from the Output window to open the 'Auto-detect output columns' dialog, where you can enter the data frame. Pyramid will then detect the given data frame and its columns in the script, and add them to the output list.

• Click here to learn more about data frame support.

Add Columns

To add columns to the output list manually, click the plus icon (green arrow below). You need to specify the data frame, column name, and data type.

Table Selection

Go to the Tables window (image below) to choose which tables to copy into the new data model. Table selection is relevant for both direct querying and data ingestion. Select the tables to copy, and then select 'Add Tables' to assign each table to an individual node, or select 'Add as Multi-Select' to copy all tables to a single node using the multi-select function.

• Click here to learn more about the Select functions.